SwaggerClient::UserApi

All URIs are relative to //api.estuary.tech/

Method	HTTP request	Description
user_api_keys_get	GET /user/api-keys	Get API keys for a user
user_api_keys_key_or_hash_delete	DELETE /user/api-keys/{key_or_hash}	Revoke a User API Key.
user_api_keys_post	POST /user/api-keys	Create API keys for a user
user_export_get	GET /user/export	Export user data
user_stats_get	GET /user/stats	Get stats for the current user

user_api_keys_get

Array<ApiGetApiKeysResp> user_api_keys_get

Get API keys for a user

This endpoint is used to get API keys for a user. In estuary, each user can be given multiple API keys (tokens). This endpoint can be used to retrieve all available API keys for a given user.

Example

# load the gem
require 'swagger_client'
# setup authorization
SwaggerClient.configure do |config|
  # Configure API key authorization: bearerAuth
  config.api_key['Authorization'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = SwaggerClient::UserApi.new

begin
  #Get API keys for a user
  result = api_instance.user_api_keys_get
  p result
rescue SwaggerClient::ApiError => e
  puts "Exception when calling UserApi->user_api_keys_get: #{e}"
end

Parameters

This endpoint does not need any parameter.

Return type

Array<ApiGetApiKeysResp>

Authorization

bearerAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

user_api_keys_key_or_hash_delete

String user_api_keys_key_or_hash_delete(key_or_hash)

Revoke a User API Key.

This endpoint is used to revoke a user API key. In estuary, every user is assigned with an API key, this API key is generated and issued for each user and is primarily used to access all estuary features. This endpoint can be used to revoke the API key that's assigned to the user. Revoked API keys are completely deleted and are not recoverable.

Example

# load the gem
require 'swagger_client'
# setup authorization
SwaggerClient.configure do |config|
  # Configure API key authorization: bearerAuth
  config.api_key['Authorization'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = SwaggerClient::UserApi.new
key_or_hash = 'key_or_hash_example' # String | Key or Hash


begin
  #Revoke a User API Key.
  result = api_instance.user_api_keys_key_or_hash_delete(key_or_hash)
  p result
rescue SwaggerClient::ApiError => e
  puts "Exception when calling UserApi->user_api_keys_key_or_hash_delete: #{e}"
end

Parameters

Name	Type	Description	Notes
key_or_hash	String	Key or Hash

Return type

String

Authorization

bearerAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

user_api_keys_post

ApiGetApiKeysResp user_api_keys_post(opts)

Create API keys for a user

This endpoint is used to create API keys for a user. In estuary, each user is given an API key to access all features.

Example

# load the gem
require 'swagger_client'
# setup authorization
SwaggerClient.configure do |config|
  # Configure API key authorization: bearerAuth
  config.api_key['Authorization'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = SwaggerClient::UserApi.new
opts = { 
  expiry: 'expiry_example', # String | Expiration - Expiration - Valid time units are ns, us (or µs),  ms,  s,  m,  h.  for  example  300h
  perms: 'perms_example' # String | Permissions -- currently unused
}

begin
  #Create API keys for a user
  result = api_instance.user_api_keys_post(opts)
  p result
rescue SwaggerClient::ApiError => e
  puts "Exception when calling UserApi->user_api_keys_post: #{e}"
end

Parameters

Name	Type	Description	Notes
expiry	String	Expiration - Expiration - Valid time units are ns, us (or µs), ms, s, m, h. for example 300h	[optional]
perms	String	Permissions -- currently unused	[optional]

Return type

ApiGetApiKeysResp

Authorization

bearerAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

user_export_get

String user_export_get

Export user data

This endpoint is used to get API keys for a user.

Example

# load the gem
require 'swagger_client'
# setup authorization
SwaggerClient.configure do |config|
  # Configure API key authorization: bearerAuth
  config.api_key['Authorization'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = SwaggerClient::UserApi.new

begin
  #Export user data
  result = api_instance.user_export_get
  p result
rescue SwaggerClient::ApiError => e
  puts "Exception when calling UserApi->user_export_get: #{e}"
end

Parameters

This endpoint does not need any parameter.

Return type

String

Authorization

bearerAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

user_stats_get

String user_stats_get

Get stats for the current user

This endpoint is used to get stats for the current user.

Example

# load the gem
require 'swagger_client'
# setup authorization
SwaggerClient.configure do |config|
  # Configure API key authorization: bearerAuth
  config.api_key['Authorization'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = SwaggerClient::UserApi.new

begin
  #Get stats for the current user
  result = api_instance.user_stats_get
  p result
rescue SwaggerClient::ApiError => e
  puts "Exception when calling UserApi->user_stats_get: #{e}"
end

Parameters

This endpoint does not need any parameter.

Return type

String

Authorization

bearerAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json